<html lang="en-US">

<head>
    
<title>聊一聊，Go 的相对路径问题 - 花落雨忧</title>

<meta property="og:title" content="聊一聊，Go 的相对路径问题 - 花落雨忧">



    



    
    <meta property="description" content="Golang 中存在各种运行方式，如何正确的引用文件路径成为一个值得商议的问题
以 gin-blog 为例，当我们在项目根目录下，执行 go run main.go 时能够正常运行（go build也是正常的）
[$ gin-blog]# go run main.go [GIN-debug] [WARNING] Running in &amp;quot;debug&amp;quot; mode. Switch &amp;hellip;">
    <meta property="og:description" content="Golang 中存在各种运行方式，如何正确的引用文件路径成为一个值得商议的问题
以 gin-blog 为例，当我们在项目根目录下，执行 go run main.go 时能够正常运行（go build也是正常的）
[$ gin-blog]# go run main.go [GIN-debug] [WARNING] Running in &amp;quot;debug&amp;quot; mode. Switch &amp;hellip;">
    






<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width,initial-scale=1">

<link rel="shortcut icon" href="https://www.lican.site/logo/logo.png" type="image/x-icon" />



<link rel="stylesheet" href="/css/style.min.css" />

<link rel="stylesheet" href="/css/reset.min.css" />




<script src="https://www.lican.site/js/highlight.min.js"></script>

<script>
hljs.configure({ ignoreUnescapedHTML: true })
hljs.highlightAll();
</script>


<script src="https://www.lican.site/js/jquery.min.js"></script>




<link href="https://www.lican.site/css/hugo-code.min.css" rel="stylesheet" />



    <style>
        .post-content img {
            max-width: 400px;
        }
    </style>
</head>

<body id="period" class="home blog">
    <a class="skip-content" href="#main">Press "Enter" to skip to content</a>
    <div id="overflow-container" class="overflow-container">
        <header class="site-header" id="site-header" role="banner">
    <div class="max-width">
        <div id="title-container" class="title-container">
            <div id="site-title" class="site-title"><a href="/">花落雨忧</a></div>
            <p class="tagline">思所及 力所行 方为真.</p>
        </div>
        
        <div id="menu-primary-container" class="menu-primary-container">
            <div class="icon-container">
            </div>
            <div id="menu-primary" class="menu-container menu-primary" role="navigation">
                <nav class="menu">
                    <ul id="menu-primary-items" class="menu-primary-items">
                        
                        
                        <li id="menu-item-0"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/posts" aria-current="page" tabindex="0">首页</a></li>
                        
                        <li id="menu-item-1"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/tech/" aria-current="page" tabindex="1">技术文档</a></li>
                        
                        <li id="menu-item-2"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/article/" aria-current="page" tabindex="2">文章</a></li>
                        
                        <li id="menu-item-3"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/project/" aria-current="page" tabindex="3">项目</a></li>
                        
                        <li id="menu-item-4"
                            class="menu-item menu-item-type-custom menu-item-object-custom ">
                            <a href="/about/" aria-current="page" tabindex="4">关于</a></li>
                        
                    </ul>
                </nav>
            </div>
        </div>
    </div>
</header>
        <div id="primary-container" class="primary-container">
            <div class="max-width">
                <section id="main" class="main" role="main">
                    <div id="loop-container" class="loop-container">
                        <div
                            class="post type-post status-publish format-standard hentry entry">
                            <article>
                                <div class="post-container">
                                    <div class="post-header">
                                        <h2 class="post-title">
                                            <a href="/posts/go/talk/2018-03-13-golang-relatively-path/">聊一聊，Go 的相对路径问题</a>
                                        </h2>
                                        
                                        <div class="post-byline">Published on
                                            <a class="date" href="javascript:;">2018/03/13</a>
                                            
                                            
                                            
                                            By 
                                            <a class="author" href="javascript:;">煎鱼</a></div>
                                            
                                        
                                    </div>
                                    <div class="post-content">
                                        <h2 id="前言">前言</h2>
<p><code>Golang</code> 中存在各种运行方式，如何<strong>正确的引用文件路径</strong>成为一个值得商议的问题</p>
<p>以 <a href="https://github.com/EDDYCJY/go-gin-example">gin-blog</a> 为例，当我们在项目根目录下，执行 <code>go run main.go</code> 时能够正常运行（<code>go build</code>也是正常的）</p>
<pre><code>[$ gin-blog]# go run main.go
[GIN-debug] [WARNING] Running in &quot;debug&quot; mode. Switch to &quot;release&quot; mode in production.
 - using env:    export GIN_MODE=release
 - using code:    gin.SetMode(gin.ReleaseMode)

[GIN-debug] GET    /api/v1/tags              --&gt; gin-blog/routers/api/v1.GetTags (3 handlers)
...
</code></pre><p>那么在不同的目录层级下，不同的方式运行，又是怎么样的呢，带着我们的疑问去学习</p>
<h2 id="问题">问题</h2>
<p>1、 go run
我们上移目录层级，到 <code>$GOPATH/src</code> 下，执行 <code>go run gin-blog/main.go</code></p>
<pre><code>[$ src]# go run gin-blog/main.go
2018/03/12 16:06:13 Fail to parse 'conf/app.ini': open conf/app.ini: no such file or directory
exit status 1
</code></pre><p>2、 go build，执行 <code>./gin-blog/main</code></p>
<pre><code>[$ src]# ./gin-blog/main
2018/03/12 16:49:35 Fail to parse 'conf/app.ini': open conf/app.ini: no such file or directory
</code></pre><p>这时候你要打一个大大的问号，就是我的程序读取到什么地方去了</p>
<hr>
<p>我们通过分析得知，<strong><code>Golang</code>的相对路径是相对于执行命令时的目录</strong>；自然也就读取不到了</p>
<h2 id="思考">思考</h2>
<p>既然已经知道问题的所在点，我们就可以寻思做点什么 : )</p>
<p>我们想到相对路径是相对执行命令的目录，那么我们获取可执行文件的地址，拼接起来不就好了吗？</p>
<h2 id="实践">实践</h2>
<p>我们编写<strong>获取当前可执行文件路径的方法</strong></p>
<pre><code>import (
	&quot;path/filepath&quot;
	&quot;os&quot;
	&quot;os/exec&quot;
	&quot;string&quot;
)

func GetAppPath() string {
    file, _ := exec.LookPath(os.Args[0])
    path, _ := filepath.Abs(file)
    index := strings.LastIndex(path, string(os.PathSeparator))

    return path[:index]
}
</code></pre><p>将其放到启动代码处查看路径</p>
<pre><code>log.Println(GetAppPath())
</code></pre><p>我们分别执行以下两个命令，查看输出结果
1、 go run</p>
<pre><code>$ go run main.go
2018/03/12 18:45:40 /tmp/go-build962610262/b001/exe
</code></pre><p>2、 go build</p>
<pre><code>$ ./main
2018/03/12 18:49:44 $GOPATH/src/gin-blog

</code></pre><h2 id="剖析">剖析</h2>
<p>我们聚焦在 <code>go run</code> 的输出结果上，发现它是一个临时文件的地址，这是为什么呢？</p>
<p>在<code>go help run</code>中，我们可以看到</p>
<pre><code>Run compiles and runs the main package comprising the named Go source files.
A Go source file is defined to be a file ending in a literal &quot;.go&quot; suffix.
</code></pre><p>也就是 <code>go run</code> 执行时会将文件放到 <code>/tmp/go-build...</code> 目录下，编译并运行</p>
<p>因此<code>go run main.go</code>出现<code>/tmp/go-build962610262/b001/exe</code>结果也不奇怪了，因为它已经跑到临时目录下去执行可执行文件了</p>
<hr>
<p>这就已经很清楚了，那么我们想想，会出现哪些问题呢</p>
<ul>
<li>依赖相对路径的文件，出现路径出错的问题</li>
<li><code>go run</code> 和 <code>go build</code> 不一样，一个到临时目录下执行，一个可手动在编译后的目录下执行，路径的处理方式会不同</li>
<li>不断<code>go run</code>，不断产生新的临时文件</li>
</ul>
<p>这其实就是<strong>根本原因</strong>了，因为 <code>go run</code> 和 <code>go build</code> 的编译文件执行路径并不同，执行的层级也有可能不一样，自然而然就出现各种读取不到的奇怪问题了</p>
<h2 id="解决方案">解决方案</h2>
<p><strong>一、获取编译后的可执行文件路径</strong></p>
<p>1、 将配置文件的相对路径与<code>GetAppPath()</code>的结果相拼接，可解决<code>go build main.go</code>的可执行文件跨目录执行的问题（如：<code>./src/gin-blog/main</code>）</p>
<pre><code>import (
	&quot;path/filepath&quot;
	&quot;os&quot;
	&quot;os/exec&quot;
	&quot;string&quot;
)

func GetAppPath() string {
    file, _ := exec.LookPath(os.Args[0])
    path, _ := filepath.Abs(file)
    index := strings.LastIndex(path, string(os.PathSeparator))

    return path[:index]
}
</code></pre><p>但是这种方式，对于<code>go run</code>依旧无效，这时候就需要2来补救</p>
<p>2、 通过传递参数指定路径，可解决<code>go run</code>的问题</p>
<pre><code>package main

import (
    &quot;flag&quot;
    &quot;fmt&quot;
)

func main() {
    var appPath string
    flag.StringVar(&amp;appPath, &quot;app-path&quot;, &quot;app-path&quot;)
    flag.Parse()
    fmt.Printf(&quot;App path: %s&quot;, appPath)
}
</code></pre><p>运行</p>
<pre><code>go run main.go --app-path &quot;Your project address&quot;
</code></pre><p><strong>二、增加<code>os.Getwd()</code>进行多层判断</strong></p>
<p>参见 <a href="https://github.com/astaxie/beego/blob/master/config.go#L133-L146">beego</a> 读取 <code>app.conf</code> 的代码</p>
<p>该写法可兼容 <code>go build</code> 和在项目根目录执行 <code>go run</code> ，但是若跨目录执行 <code>go run</code> 就不行</p>
<p><strong>三、配置全局系统变量</strong></p>
<p>我们可以通过<code>os.Getenv</code>来获取系统全局变量，然后与相对路径进行拼接</p>
<p>1、 设置项目工作区</p>
<p>简单来说，就是设置项目（应用）的工作路径，然后与配置文件、日志文件等相对路径进行拼接，达到相对的绝对路径来保证路径一致</p>
<p>参见 <a href="https://github.com/gogits/gogs/blob/master/pkg/setting/setting.go#L351">gogs</a> 读取<code>GOGS_WORK_DIR</code>进行拼接的代码</p>
<p>2、 利用系统自带变量</p>
<p>简单来说就是通过系统自带的全局变量，例如<code>$HOME</code>等，将配置文件存放在<code>$HOME/conf</code>或<code>/etc/conf</code>下</p>
<p>这样子就能更加固定的存放配置文件，<strong>不需要额外去设置一个环境变量</strong></p>
<p>（这点今早与一位SFer讨论了一波，感谢）</p>
<h2 id="拓展">拓展</h2>
<p><code>go test</code> 在一些场景下也会遇到路径问题，因为<code>go test</code>只能够在当前目录执行，所以在执行测试用例的时候，你的执行目录已经是测试目录了</p>
<p>需要注意的是，如果采用获取外部参数的办法，用 <code>os.args</code> 时，<code>go test -args</code> 和 <code>go run</code>、<code>go build</code> 会有命令行参数位置的不一致问题</p>
<h2 id="小结">小结</h2>
<p>这三种解决方案，在目前可见的开源项目或介绍中都能找到这些的身影</p>
<p>优缺点也是显而易见的，我认为应在<strong>不同项目选定合适的解决方案</strong>即可</p>
<p>建议大家不要强依赖读取配置文件的模块，应当将其“堆积木”化，<strong>需要什么配置才去注册什么配置变量</strong>，可以解决一部分的问题</p>
<p>大家又有什么想法呢，一起讨论一波？</p>


                                        
                                        
                                        
                                        <div class="rp4wp-related-posts">
                                            <h3>相关文章</h3>
                                            <ul>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/grpc-gateway/2018-03-04-swagger/">「连载三」Swagger了解一下</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/grpc-gateway/2018-02-27-hello-world/">「连载二」Hello World</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/grpc-gateway/2018-02-23-install/">「连载一」gRPC介绍与环境安装</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/gin/2018-02-15-log/">「连载六」编写一个简单的文件日志</a>
                                                    </div>
                                                </li>
                                                
                                                <li>
                                                    <div class="rp4wp-related-post-content">
                                                        <a
                                                            href="https://www.lican.site/posts/go/gin/2018-02-14-jwt/">「连载五」使用 JWT 进行身份校验</a>
                                                    </div>
                                                </li>
                                                
                                            </ul>
                                        </div>
                                        
                                        
                                    </div>

                                    
                                    
                                    

                                    
                                    <div class="post-meta">
                                        
                                        
                                        <div class="post-tags">
                                            <ul>
                                            
                                            <li>
                                                <a href="/tags/go" title="View all posts tagged match">go</a>
                                            </li>
                                            
                                            </ul>
                                        </div>
                                        
                                        
                                        <nav class="further-reading">
                                            
                                            <div class="previous">
                                                <span>&lt;&lt; Prev</span>
                                                <a href="https://www.lican.site/posts/go/grpc-gateway/2018-03-04-swagger/"
                                                    rel="prev">「连载三」Swagger了解一下</a> </div>
                                            
                                            
                                            <div class="next">
                                                <span>Next >></span>
                                                <a href="https://www.lican.site/posts/go/gin/2018-03-15-reload-http/">「连载七」优雅的重启服务</a> 
                                            </div>
                                            
                                        </nav>
                                    </div>
                                    
                                    

                                    
                                    
                                    

                                </div>
                            </article>
                        </div>
                    </div>
                </section>
                <aside class="sidebar sidebar-primary" id="sidebar-primary" role="complementary">
    <h1 class="screen-reader-text">Sidebar</h1>
    

    
    
    <section id="text-2" class="widget widget_text">
        <div class="textwidget">
            
            <div id="profile">
                <div id="profile_picture"><img src="https://www.lican.site/logo/logo.png"></div>
                <div id="profile_intro">
                    <p><span class="name">Lican</span></p>
                    <p class="intro">全栈开发者，爱好造轮子。</p>
                </div>
            </div>
            
            <p>
                <script type="text/javascript">
                    (function ($) {
                        $(document).ready(function () {
                            var menuPrimaryContainer = $('#menu-primary-container');
                            var profile = $('#text-2');
                            $('#toggle-navigation').click(function () {
                                if (menuPrimaryContainer.hasClass('open')) {
                                    profile.removeClass('open');
                                } else {
                                    profile.addClass('open');
                                }
                            });
                        });
                    })(jQuery);
                </script>
            </p>
        </div>
    </section>
    
    
    
    
    
    <section id="text-5" class="widget widget_text">
        <h2 class="widget-title">开源项目</h2>
        <div class="textwidget">
            <div id="projects" style="line-height: 22px;">
                
                <a href="https://github.com/idoubi/gonews"
                    target="_blank">gonews</a>: &nbsp;Daily news for golang<br>
                
                <a href="https://github.com/idoubi/sql2struct"
                    target="_blank">sql2struct</a>: &nbsp;Generate go struct according to SQL<br>
                
                <a href="https://github.com/idoubi/goz"
                    target="_blank">goz</a>: &nbsp;Request library used in golang<br>
                
        </div>
    </section>
    
    

    
    
    
    
    

    
    
    

    
    
    

    
    
    
    
</aside>
            </div>
        </div>

        <footer id="site-footer" class="site-footer" role="contentinfo">
    <div class="max-width">
    </div>
    <div class="footer">
        <div id="footercontent">
            © lican.vip All rights reserved<br/>
            Built with Hugo Theme <a href="https://github.com/idoubi/hugo-theme-period" target="_blank">Period</a>
        </div>
    </div>
</footer>

<script>
    var _hmt = _hmt || [];
    (function() {
      var hm = document.createElement("script");
      hm.src = "https://hm.baidu.com/hm.js?e8351b6d4626d5881d439ea1f6184baa";
      var s = document.getElementsByTagName("script")[0]; 
      s.parentNode.insertBefore(hm, s);
    })();
</script>
    
    
    </div>
    
</body>

</html>